home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / XmConvertUnits.z / XmConvertUnits
Encoding:
Text File  |  2002-10-03  |  5.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss - A function that converts a value in one
  10.           unit type to another unit type
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////XXXXmmmm....hhhh>>>>
  14.  
  15.           iiiinnnntttt XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss ((((_w_i_d_g_e_t, _o_r_i_e_n_t_a_t_i_o_n, _f_r_o_m__u_n_i_t__t_y_p_e,
  16.                     _f_r_o_m__v_a_l_u_e, _t_o__u_n_i_t__t_y_p_e))))
  17.                WWWWiiiiddddggggeeeetttt    _w_i_d_g_e_t;;;;
  18.                iiiinnnntttt       _o_r_i_e_n_t_a_t_i_o_n;;;;
  19.                iiiinnnntttt       _f_r_o_m__u_n_i_t__t_y_p_e;;;;
  20.                iiiinnnntttt       _f_r_o_m__v_a_l_u_e;;;;
  21.                iiiinnnntttt       _t_o__u_n_i_t__t_y_p_e;;;;
  22.  
  23.  
  24.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  25.           This page documents version 1.2 of the Motif library.
  26.  
  27.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.           XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss converts the value and returns it as the
  29.           return value from the function.
  30.  
  31.  
  32.           _w_i_d_g_e_t      Specifies the widget for which the data is to be
  33.                       converted
  34.  
  35.           _o_r_i_e_n_t_a_t_i_o_n Specifies whether the converter uses the
  36.                       horizontal or vertical screen resolution when
  37.                       performing the conversions.  _o_r_i_e_n_t_a_t_i_o_n can
  38.                       have values of XXXXmmmmHHHHOOOORRRRIIIIZZZZOOOONNNNTTTTAAAALLLL or XXXXmmmmVVVVEEEERRRRTTTTIIIICCCCAAAALLLL.
  39.  
  40.           _f_r_o_m__u_n_i_t__t_y_p_e
  41.                       Specifies the current unit type of the supplied
  42.                       value
  43.  
  44.           _f_r_o_m__v_a_l_u_e  Specifies the value to be converted
  45.  
  46.           _t_o__u_n_i_t__t_y_p_e
  47.                       Converts the value to the unit type specified
  48.  
  49.  
  50.           The parameters _f_r_o_m__u_n_i_t__t_y_p_e and _t_o__u_n_i_t__t_y_p_e can have the
  51.           following values:
  52.  
  53.  
  54.             +o  XXXXmmmmPPPPIIIIXXXXEEEELLLLSSSS-all values provided to the widget are treated
  55.                as normal pixel values.  This is the default for the
  56.                resource.
  57.  
  58.             +o  XXXXmmmm111100000000TTTTHHHH____MMMMIIIILLLLLLLLIIIIMMMMEEEETTTTEEEERRRRSSSS-all values provided to the widget
  59.                are treated as 1/100 millimeter.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss((((3333XXXX))))
  71.  
  72.  
  73.  
  74.             +o  XXXXmmmm1111000000000000TTTTHHHH____IIIINNNNCCCCHHHHEEEESSSS-all values provided to the widget are
  75.                treated as 1/1000 inch.
  76.  
  77.             +o  XXXXmmmm111100000000TTTTHHHH____PPPPOOOOIIIINNNNTTTTSSSS-all values provided to the widget are
  78.                treated as 1/100 point.  A point is a unit typically
  79.                used in text processing applications and is defined as
  80.                1/72 inch.
  81.  
  82.             +o  XXXXmmmm111100000000TTTTHHHH____FFFFOOOONNNNTTTT____UUUUNNNNIIIITTTTSSSS-all values provided to the widget
  83.                are treated as 1/100 of a font unit.  A font unit has
  84.                horizontal and vertical components.  These are the
  85.                values of the XmScreen resources XXXXmmmmNNNNhhhhoooorrrriiiizzzzoooonnnnttttaaaallllFFFFoooonnnnttttUUUUnnnniiiitttt
  86.                and XXXXmmmmNNNNvvvveeeerrrrttttiiiiccccaaaallllFFFFoooonnnnttttUUUUnnnniiiitttt.
  87.  
  88.  
  89.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  90.           Returns the converted value.  If a NULL widget, incorrect
  91.           _o_r_i_e_n_t_a_t_i_o_n, or incorrect _u_n_i_t__t_y_p_e is supplied as parameter
  92.           data, 0 is returned.
  93.  
  94.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  95.           XXXXmmmmSSSSeeeettttFFFFoooonnnnttttUUUUnnnniiiittttssss((((3333XXXX)))) and XXXXmmmmSSSSccccrrrreeeeeeeennnn((((3333XXXX)))).
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.